feat: Add multi directory support by command line option #4939
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @y-okt, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly enhances the CLI's capabilities by introducing multi-directory support, allowing users to define a virtual workspace that spans across various file system locations. This foundational change integrates multi-directory awareness throughout the application, from argument parsing and core configuration to individual file-system manipulation tools and sandbox permissions, ultimately improving workflow flexibility and the model's contextual understanding of the user's environment.
Highlights
- New CLI Option: Multi-Directory Support: I've introduced a new command-line option,
--include-directories, which allows users to specify additional directories to be included in the CLI's virtual workspace. This enables working with files and folders from disparate locations within a single session. - Core Workspace Management: A new
WorkspaceContextclass has been implemented in the core library. This class is responsible for managing all active workspace directories, resolving real paths, and providing robust validation to ensure all file operations occur within the defined workspace boundaries. - Enhanced Tool Functionality: Existing file-system related tools, including
edit,glob,grep,ls,read-file,read-many-files, andshell, have been updated to leverage the newWorkspaceContext. This allows them to operate seamlessly across all included directories, providing a more comprehensive and flexible user experience. - Sandbox Compatibility: I've made necessary adjustments to the macOS sandbox profiles (
.sbfiles) to ensure that file operations performed by tools likeeditandwrite-filecan correctly access and modify files within the newly included directories, maintaining security while expanding functionality. - Improved Contextual Awareness: The CLI's environment context, which is provided to the underlying language model, now includes information about all active workspace directories. This gives the model a more complete understanding of the user's project structure, even when it spans multiple locations.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
@jacob314 @allenhutchison Could you please review this PR? I addressed your previous reviews in #4605 and separated PRs. This one is responsible for |
There was a problem hiding this comment.
Code Review
This pull request introduces multi-directory support via the --include-directories command-line option, which enhances workspace flexibility. The implementation includes configuration parsing, sandbox profile updates, and modifications to file-system-related tools. The introduction of WorkspaceContext is a good choice for centralizing path validation and ensuring security. Addressing the identified issues in InputPrompt.tsx and atCommandProcessor.ts will improve the stability and predictability of this feature.
|
Incorporated this change into #4605. Closing this PR |
1 participant
TLDR
As described in #1118, enable users to include files and folders from disparate locations within a single session, creating a virtual workspace. This will improve workflow flexibility, especially when related project files are spread across different folders.
This was partially implemented in #4605 , and was suggested by @jacob314 to separate PRs, and this is one of the PRs to add
--include-directoriesoption. In another PR, I'm planning to work on/directory add <dir>,/directory show, and configuration supports.Dive Deeper
Supported
--include-directoriesflag. By this flag, the following features are supported.Reviewer Test Plan
ReadFile
"@" command
Edit
Write
ReadManyFiles
shell
Testing Matrix
Linked issues / bugs
Partially resolve #1118 . Having
/directorycommand and having JSON config (suggested by @allenhutchison (comment) would be the next steps